Conversation
xylar
added
conda package
documentation
ci
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation build process and enhances documentation quality by making builds stricter (treating warnings as errors), fixing formatting inconsistencies, and improving docstring clarity. The changes ensure better documentation maintainability and consistency across the project.
Key Changes:
- Implemented WERROR flag in Makefile to treat Sphinx warnings as errors during documentation builds, enabled in CI
- Fixed reStructuredText formatting issues including reference label positioning, note block indentation, and duplicate lines
- Improved docstring formatting in Python code and fixed Sphinx autosummary method references
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| conda_package/mpas_tools/viz/mpas_to_xdmf/mpas_to_xdmf.py | Improved docstring formatting with proper reStructuredText syntax for lists and code literals |
| conda_package/docs/releasing.rst | Converted Markdown link to reStructuredText format and improved spacing |
| conda_package/docs/mpas_to_xdmf.rst | Fixed note block indentation for proper rendering |
| conda_package/docs/mesh_creation.rst | Moved reference label after unicode directive following reStructuredText best practices |
| conda_package/docs/mesh_conversion.rst | Removed duplicate line and added command help text example |
| conda_package/docs/interpolation.rst | Moved reference label after unicode directive following reStructuredText best practices |
| conda_package/docs/conf.py | Updated intersphinx Python docs URL to Python 3 specific version |
| conda_package/docs/api.rst | Added reference label and fixed method references (removed parentheses) |
| conda_package/docs/Makefile | Implemented WERROR flag mechanism to optionally treat Sphinx warnings as errors |
| .github/workflows/build_workflow.yml | Enabled WERROR flag in CI documentation builds |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
xylar
force-pushed
the
fix-docs
branch
8 times, most recently
from
e33ddaa to
337af6b
Compare
Fix various formatting errors causing warnings in docs build.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces improvements to the documentation build process, enhances the clarity and formatting of the documentation, and updates some docstrings and configuration. The main focus is on making documentation builds stricter (treating warnings as errors), improving Sphinx configuration, and refining the documentation for better usability and consistency.